Skip to content

Fetching a single Estimate Scenario Resource

Request

This endpoint returns structured Estimate Scenario Resource objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the estimate_scenario_resources top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • geography (Geography) - The Geography of the Estimate Scenario Resource.
  • organization_membership (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include organization_membership_id, which references the data in the organization_memberships top-level key.
  • role (Role)
  • user (User).
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/estimate_scenario_resources/{id}?include=string'

Responses

The Estimate Scenario Resource has been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
estimate_scenario_resourcesobject
external_referencesobject
usersobject
rolesobject
organization_membershipsobject
estimate_scenario_resource_allocationsobject
organizationsobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "estimate_scenario_resources": { "property1": { "allocation_id": "string", "bill_rate": 0, "cost_rate": 0, "created_at": "2019-08-24T14:15:22Z", "display_label": "string", "estimate_scenario_id": 0, "external_reference_ids": [ "string" ], "geography_id": "string", "label": "string", "organization_membership_id": "string", "role_id": "string", "role_name": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" }, "property2": { "allocation_id": "string", "bill_rate": 0, "cost_rate": 0, "created_at": "2019-08-24T14:15:22Z", "display_label": "string", "estimate_scenario_id": 0, "external_reference_ids": [ "string" ], "geography_id": "string", "label": "string", "organization_membership_id": "string", "role_id": "string", "role_name": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "roles": { "property1": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "organization_memberships": { "property1": { "created_at": "2019-08-24T14:15:22Z", "department_id": "string", "effective_end_date": "2019-08-24", "effective_start_date": "2019-08-24", "geography_id": "string", "member_id": "string", "member_type": "string", "primary": true, "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "department_id": "string", "effective_end_date": "2019-08-24", "effective_start_date": "2019-08-24", "geography_id": "string", "member_id": "string", "member_type": "string", "primary": true, "updated_at": "2019-08-24T14:15:22Z" } }, "estimate_scenario_resource_allocations": { "property1": { "created_at": "2019-08-24T14:15:22Z", "duration_days": 0, "percent_allocated": 0.1, "relative_start_day": 0, "resource_id": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "duration_days": 0, "percent_allocated": 0.1, "relative_start_day": 0, "resource_id": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "organizations": { "property1": { "ancestor_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "name": "string", "parent_id": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "ancestor_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "name": "string", "parent_id": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z" } } }